Skip to content

Accessibility: add alt text to the HTTP API flow diagram - #170

Draft
recrwplay wants to merge 1 commit into
neo4j:devfrom
recrwplay:a11y-alt-text-and-table-headers
Draft

Accessibility: add alt text to the HTTP API flow diagram#170
recrwplay wants to merge 1 commit into
neo4j:devfrom
recrwplay:a11y-alt-text-and-table-headers

Conversation

@recrwplay

@recrwplay recrwplay commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

What

Added descriptive alt text to the HTTP API transaction flow diagram in endpoints.adoc (WCAG 1.1.1). It previously had only a title attribute and no alt text.

The curly-brace placeholders in the alt text (POST /tx/{n}) are escaped as \{n} so Asciidoctor does not try to resolve them as attribute references.

Note

The request/response header tables (headers.adoc) and endpoints table already render proper <th> header cells via Asciidoctor's implicit header-row detection (first row on a single line followed by a blank line), so no table changes were needed.

Verification

npm run verify:preview completes with no warnings/errors, and the rendered <img> carries the full alt text with {n} intact.

🤖 Generated with Claude Code

@recrwplay
recrwplay force-pushed the a11y-alt-text-and-table-headers branch from a80a024 to 27ad0f7 Compare July 14, 2026 11:25
Add descriptive alt text to the HTTP API transaction flow diagram in
endpoints.adoc, which previously had only a title and no alt (WCAG
1.1.1). Curly-brace placeholders in the alt text are escaped so
Asciidoctor does not treat them as attribute references.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@recrwplay
recrwplay force-pushed the a11y-alt-text-and-table-headers branch from 27ad0f7 to a973803 Compare July 14, 2026 11:52
@recrwplay recrwplay changed the title Accessibility: image alt text and table headers Accessibility: add alt text to the HTTP API flow diagram Jul 14, 2026
@neo4j-docops-agent

Copy link
Copy Markdown
Collaborator

This PR includes documentation updates
View the updated docs at https://neo4j-docs-http-api-170.surge.sh

Updated pages:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants